<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8" />
  <title>tf::Semaphore class | Taskflow QuickStart</title>
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
  <link rel="stylesheet" href="m-dark+documentation.compiled.css" />
  <link rel="icon" href="favicon.ico" type="image/x-icon" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <meta name="theme-color" content="#22272e" />
</head>
<body>
<header><nav id="navigation">
  <div class="m-container">
    <div class="m-row">
      <span id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">
        <a href="https://taskflow.github.io"><img src="taskflow_logo.png" alt="" />Taskflow</a> <span class="m-breadcrumb">|</span> <a href="index.html" class="m-thin">QuickStart</a>
      </span>
      <div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
        <a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
          <path id="m-doc-search-icon-path" d="m6 0c-3.31 0-6 2.69-6 6 0 3.31 2.69 6 6 6 1.49 0 2.85-0.541 3.89-1.44-0.0164 0.338 0.147 0.759 0.5 1.15l3.22 3.79c0.552 0.614 1.45 0.665 2 0.115 0.55-0.55 0.499-1.45-0.115-2l-3.79-3.22c-0.392-0.353-0.812-0.515-1.15-0.5 0.895-1.05 1.44-2.41 1.44-3.89 0-3.31-2.69-6-6-6zm0 1.56a4.44 4.44 0 0 1 4.44 4.44 4.44 4.44 0 0 1-4.44 4.44 4.44 4.44 0 0 1-4.44-4.44 4.44 4.44 0 0 1 4.44-4.44z"/>
        </svg></a>
        <a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
        <a id="m-navbar-hide" href="#" title="Hide navigation"></a>
      </div>
      <div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
        <div class="m-row">
          <ol class="m-col-t-6 m-col-m-none">
            <li><a href="pages.html">Handbook</a></li>
            <li><a href="namespaces.html">Namespaces</a></li>
          </ol>
          <ol class="m-col-t-6 m-col-m-none" start="3">
            <li><a href="annotated.html">Classes</a></li>
            <li><a href="files.html">Files</a></li>
            <li class="m-show-m"><a href="#search" class="m-doc-search-icon" title="Search" onclick="return showSearch()"><svg style="height: 0.9rem;" viewBox="0 0 16 16">
              <use href="#m-doc-search-icon-path" />
            </svg></a></li>
          </ol>
        </div>
      </div>
    </div>
  </div>
</nav></header>
<main><article>
  <div class="m-container m-container-inflatable">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <h1>
          <span class="m-breadcrumb"><a href="namespacetf.html">tf</a>::<wbr/></span>Semaphore <span class="m-thin">class</span>
        </h1>
        <p>class to create a semophore object for building a concurrency constraint</p>
        <nav class="m-block m-default">
          <h3>Contents</h3>
          <ul>
            <li>
              Reference
              <ul>
                <li><a href="#typeless-methods">Constructors, destructors, conversion operators</a></li>
                <li><a href="#pub-methods">Public functions</a></li>
              </ul>
            </li>
          </ul>
        </nav>
<p>A semaphore creates a constraint that limits the maximum concurrency, i.e., the number of workers, in a set of tasks. You can let a task acquire/release one or multiple semaphores before/after executing its work. A task can acquire and release a semaphore, or just acquire or just release it. A <a href="classtf_1_1Semaphore.html" class="m-doc">tf::<wbr />Semaphore</a> object starts with an initial count. As long as that count is above 0, tasks can acquire the semaphore and do their work. If the count is 0 or less, a task trying to acquire the semaphore will not run but goes to a waiting list of that semaphore. When the semaphore is released by another task, it reschedules all tasks on that waiting list.</p><pre class="m-code"><span class="n">tf</span><span class="o">::</span><span class="n">Executor</span><span class="w"> </span><span class="nf">executor</span><span class="p">(</span><span class="mi">8</span><span class="p">);</span><span class="w">   </span><span class="c1">// create an executor of 8 workers</span>
<span class="n">tf</span><span class="o">::</span><span class="n">Taskflow</span><span class="w"> </span><span class="n">taskflow</span><span class="p">;</span>

<span class="n">tf</span><span class="o">::</span><span class="n">Semaphore</span><span class="w"> </span><span class="nf">semaphore</span><span class="p">(</span><span class="mi">1</span><span class="p">);</span><span class="w"> </span><span class="c1">// create a semaphore with initial count 1</span>

<span class="k">for</span><span class="p">(</span><span class="kt">size_t</span><span class="w"> </span><span class="n">i</span><span class="o">=</span><span class="mi">0</span><span class="p">;</span><span class="w"> </span><span class="n">i</span><span class="o">&lt;</span><span class="mi">1000</span><span class="p">;</span><span class="w"> </span><span class="n">i</span><span class="o">++</span><span class="p">)</span><span class="w"> </span><span class="p">{</span>
<span class="w">  </span><span class="n">taskflow</span><span class="p">.</span><span class="n">emplace</span><span class="p">([</span><span class="o">&amp;</span><span class="p">](</span><span class="n">tf</span><span class="o">::</span><span class="n">Runtime</span><span class="o">&amp;</span><span class="w"> </span><span class="n">rt</span><span class="p">){</span><span class="w"> </span>
<span class="w">    </span><span class="n">rt</span><span class="p">.</span><span class="n">acquire</span><span class="p">(</span><span class="n">semaphore</span><span class="p">);</span>
<span class="w">    </span><span class="n">std</span><span class="o">::</span><span class="n">cout</span><span class="w"> </span><span class="o">&lt;&lt;</span><span class="w"> </span><span class="s">&quot;critical section here (one worker at any time)</span><span class="se">\n</span><span class="s">&quot;</span><span class="p">;</span><span class="w"> </span>
<span class="w">    </span><span class="n">critical_section</span><span class="p">();</span>
<span class="w">    </span><span class="n">rt</span><span class="p">.</span><span class="n">release</span><span class="p">(</span><span class="n">semaphore</span><span class="p">);</span>
<span class="w">  </span><span class="p">});</span>
<span class="p">}</span>

<span class="n">executor</span><span class="p">.</span><span class="n">run</span><span class="p">(</span><span class="n">taskflow</span><span class="p">).</span><span class="n">wait</span><span class="p">();</span></pre><p>The above example creates a taskflow of 1000 independent tasks while only one worker will run <code>critical_section</code> at any time due to the semaphore constraint. This arrangement limits the parallelism of <code>critical_section</code> to just one.</p><aside class="m-note m-info"><h4>Note</h4><p>Taskflow use a non-blocking algorithm to implement the acquisition of semaphores and thus is deadlock-free.</p></aside>
        <section id="typeless-methods">
          <h2><a href="#typeless-methods">Constructors, destructors, conversion operators</a></h2>
          <dl class="m-doc">
            <dt>
              <span class="m-doc-wrap-bumper"><a href="#aafbb7c98f5e510f2ba053b3e9fd2cb25" class="m-doc">Semaphore</a>(</span><span class="m-doc-wrap">size_t count) <span class="m-label m-flat m-info">explicit</span> </span>
            </dt>
            <dd>constructs a semaphore with the given counter</dd>
          </dl>
        </section>
        <section id="pub-methods">
          <h2><a href="#pub-methods">Public functions</a></h2>
          <dl class="m-doc">
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#ad6e2debbcbfba34ad5ec72057a3981f7" class="m-doc">count</a>(</span><span class="m-doc-wrap">std::memory_order memory_order = std::memory_order_relaxed) const -&gt; size_t</span>
            </dt>
            <dd>queries the counter value (not thread-safe during the run)</dd>
            <dt>
              <span class="m-doc-wrap-bumper">auto <a href="#a2bbcb0be1e7e767d5911ad79d63b59f0" class="m-doc">try_acquire</a>(</span><span class="m-doc-wrap">) -&gt; bool</span>
            </dt>
            <dd>tries to atomically decrement the internal counter by <code>1</code> if it is greater than <code>0</code></dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#a495348aa6280a4d2756a42fbf23fbe20" class="m-doc">release</a>(</span><span class="m-doc-wrap">size_t n = 1)</span>
            </dt>
            <dd>tries to atomically increment the internal counter by <code>n</code></dd>
            <dt>
              <span class="m-doc-wrap-bumper">void <a href="#a6210744dd39283c3f2d5a89370d1b6b9" class="m-doc">reset</a>(</span><span class="m-doc-wrap">size_t count,
              std::memory_order memory_order = std::memory_order_relaxed)</span>
            </dt>
            <dd>resets the semaphore to the given count</dd>
          </dl>
        </section>
        <section>
          <h2>Function documentation</h2>
          <section class="m-doc-details" id="aafbb7c98f5e510f2ba053b3e9fd2cb25"><div>
            <h3>
              <span class="m-doc-wrap-bumper"> tf::<wbr />Semaphore::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#aafbb7c98f5e510f2ba053b3e9fd2cb25" class="m-doc-self">Semaphore</a>(</span><span class="m-doc-wrap">size_t count) <span class="m-label m-info">explicit</span> </span></span>
            </h3>
            <p>constructs a semaphore with the given counter</p>
<p>A semaphore creates a constraint that limits the maximum concurrency, i.e., the number of workers, in a set of tasks.</p><pre class="m-code"><span class="n">tf</span><span class="o">::</span><span class="n">Semaphore</span><span class="w"> </span><span class="nf">semaphore</span><span class="p">(</span><span class="mi">4</span><span class="p">);</span><span class="w">  </span><span class="c1">// a semaphore initialized with 4</span></pre>
          </div></section>
          <section class="m-doc-details" id="ad6e2debbcbfba34ad5ec72057a3981f7"><div>
            <h3>
              <span class="m-doc-wrap-bumper">size_t tf::<wbr />Semaphore::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#ad6e2debbcbfba34ad5ec72057a3981f7" class="m-doc-self">count</a>(</span><span class="m-doc-wrap">std::memory_order memory_order = std::memory_order_relaxed) const</span></span>
            </h3>
            <p>queries the counter value (not thread-safe during the run)</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">memory_order</td>
                  <td>the memory order of this load (default std::memory_order_relaxed)</td>
                </tr>
              </tbody>
            </table>
          </div></section>
          <section class="m-doc-details" id="a2bbcb0be1e7e767d5911ad79d63b59f0"><div>
            <h3>
              <span class="m-doc-wrap-bumper">bool tf::<wbr />Semaphore::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a2bbcb0be1e7e767d5911ad79d63b59f0" class="m-doc-self">try_acquire</a>(</span><span class="m-doc-wrap">)</span></span>
            </h3>
            <p>tries to atomically decrement the internal counter by <code>1</code> if it is greater than <code>0</code></p>
            <table class="m-table m-fullwidth m-flat">
              <tfoot>
                <tr>
                  <th style="width: 1%">Returns</th>
                  <td><code>true</code> if it decremented the internal counter, otherwise <code>false</code></td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="a495348aa6280a4d2756a42fbf23fbe20"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void tf::<wbr />Semaphore::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a495348aa6280a4d2756a42fbf23fbe20" class="m-doc-self">release</a>(</span><span class="m-doc-wrap">size_t n = 1)</span></span>
            </h3>
            <p>tries to atomically increment the internal counter by <code>n</code></p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">n</td>
                  <td>the value by which the internal counter will be incremented</td>
                </tr>
              </tbody>
              <tfoot>
                <tr>
                  <th>Returns</th>
                  <td><code>true</code> if it decremented the internal counter, otherwise <code>false</code></td>
                </tr>
              </tfoot>
            </table>
          </div></section>
          <section class="m-doc-details" id="a6210744dd39283c3f2d5a89370d1b6b9"><div>
            <h3>
              <span class="m-doc-wrap-bumper">void tf::<wbr />Semaphore::<wbr /></span><span class="m-doc-wrap"><span class="m-doc-wrap-bumper"><a href="#a6210744dd39283c3f2d5a89370d1b6b9" class="m-doc-self">reset</a>(</span><span class="m-doc-wrap">size_t count,
              std::memory_order memory_order = std::memory_order_relaxed)</span></span>
            </h3>
            <p>resets the semaphore to the given count</p>
            <table class="m-table m-fullwidth m-flat">
              <thead>
                <tr><th colspan="2">Parameters</th></tr>
              </thead>
              <tbody>
                <tr>
                  <td style="width: 1%">count</td>
                  <td>the new count value</td>
                </tr>
                <tr>
                  <td>memory_order</td>
                  <td>memory order to which this operation will be applied</td>
                </tr>
              </tbody>
            </table>
          </div></section>
        </section>
      </div>
    </div>
  </div>
</article></main>
<div class="m-doc-search" id="search">
  <a href="#!" onclick="return hideSearch()"></a>
  <div class="m-container">
    <div class="m-row">
      <div class="m-col-m-8 m-push-m-2">
        <div class="m-doc-search-header m-text m-small">
          <div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
          <div id="search-symbolcount">&hellip;</div>
        </div>
        <div class="m-doc-search-content">
          <form>
            <input type="search" name="q" id="search-input" placeholder="Loading &hellip;" disabled="disabled" autofocus="autofocus" autocomplete="off" spellcheck="false" />
          </form>
          <noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
          <div id="search-help" class="m-text m-dim m-text-center">
            <p class="m-noindent">Search for symbols, directories, files, pages or
            modules. You can omit any prefix from the symbol or file path; adding a
            <code>:</code> or <code>/</code> suffix lists all members of given symbol or
            directory.</p>
            <p class="m-noindent">Use <span class="m-label m-dim">&darr;</span>
            / <span class="m-label m-dim">&uarr;</span> to navigate through the list,
            <span class="m-label m-dim">Enter</span> to go.
            <span class="m-label m-dim">Tab</span> autocompletes common prefix, you can
            copy a link to the result using <span class="m-label m-dim">⌘</span>
            <span class="m-label m-dim">L</span> while <span class="m-label m-dim">⌘</span>
            <span class="m-label m-dim">M</span> produces a Markdown link.</p>
          </div>
          <div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
          <ul id="search-results"></ul>
        </div>
      </div>
    </div>
  </div>
</div>
<script src="search-v2.js"></script>
<script src="searchdata-v2.js" async="async"></script>
<footer><nav>
  <div class="m-container">
    <div class="m-row">
      <div class="m-col-l-10 m-push-l-1">
        <p>Taskflow handbook is part of the <a href="https://taskflow.github.io">Taskflow project</a>, copyright © <a href="https://tsung-wei-huang.github.io/">Dr. Tsung-Wei Huang</a>, 2018&ndash;2024.<br />Generated by <a href="https://doxygen.org/">Doxygen</a> 1.9.6 and <a href="https://mcss.mosra.cz/">m.css</a>.</p>
      </div>
    </div>
  </div>
</nav></footer>
</body>
</html>
